ACH INBOUND

The ACH IN API enables to process incoming Automated Clearing House (ACH) transactions.

Method: POST

{{localCEUrl}}/analytics/rest/eventApi/event

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
InstructionIdentification Mandatory	String Unique identifier of the payment instruction Example – " f9a820da-7bcd-4941-b85c-201169ccf41a"
EndToEndIdentification Optional	String Unique identifier to track the transaction any time during the process Example – " 31fe4401-d804-441e-b67a-44016b99b08f"
BeneficiaryInformation Optional	String Information of the beneficiary Example – " Client Refund"
Reason Optional	String Reason or purpose given for the transaction Example – " Loan Repayment"
Channel Optional	String Channel through which the transaction happens Example – "ACH"
TransactionType Optional	String Type of transaction Example – "ACH_CREDIT"
TransactionCode Optional	String Specific code for the transaction type Example – "ACH_CREDIT_CCD"
Source Optional	String Name of the source system from where the payment request is initiated Example – "LEDGER"
TransactionAmount Mandatory	Object
Amount Mandatory	String Amount of the transaction Example – "251.00"
Currency Mandatory	String Currency type of the transaction amount Example – "USD"
Debtor Required	Object
CustomerType Optional	String Customer type of the debtor (sender), which can possibly be the ‘Account Holder', ‘Non-account Holder', ‘Account Holder Business' or ‘TSP' Example – "EXTERNAL"
UserType Optional	String User type of the debtor Example – "UNKNOWN"
CustomerNumber Optional	String Unique ID provided for the debtor as a customer Example – "1834177889"
InstitutionNumber Optional	String Unique ID that identifies the financial institution Example – "123456789012345"
Name Required	String Customer name of the debtor Example – "Jhon Doe"
DebtorAccount Optional	Object
AccountNumber Optional	String Account number of the debtor Example – "-"
AccountType Optional	String Type of the debtor's account Example – "CHECKING"
AccountName Optional	String Debtor's account name Example – "GENERAL ACCOUNT"
Institution Optional	Object
Identification Optional	String Identification code of the debtor account financial institution, which is possibly the routing number Example – "021000018"
IdentificationType Optional	String Identification type of the debtor account financial institution Example – "ABA"
Name Optional	String Name of the debtor account financial institution Example – "Bank Of New York"
Creditor Required	Object
CustomerType Optional	String Customer type of the creditor (receiver), which can possibly be the ‘Account Holder', ‘Account Holder Business' or ‘TSP' Example – "ACCOUNT_HOLDER_BUSINESS"
UserType Optional	String User type of the creditor Example – "INDIVIDUAL"
Identification Optional	String Individual ID of the creditor Example – "994140005"
IdentificationType Optional	String Type of identification used for individual ID Example – "SSN"
CustomerNumber Optional	String Unique ID provided for the creditor as a customer Example – "169728101301663"
Name Required	String Customer name of the creditor Example – "Lucy Ballard"
NameInFile Optional	String Name of the creditor given in the payment instruction Example – "Lucy B"
CreditorAccount Optional	Object
AccountNumber Optional	String Account number of the creditor Example – "200162780837000"
AccountType Optional	String Type of the creditor's account Example – "CHECKING"
AccountName Optional	String Creditor's account name Example – "Payments Account"
Institution Optional	Object
Name Optional	String Name of the creditor account financial institution Example – "Union Savings Bank"
Identification Optional	String Identification code of the creditor account financial institution, which is possibly the routing number Example – "011102502"
IdentificationType Optional	String Identification type of the creditor account financial institution Example – "ABA"
CreditorDateOfBirth Optional	Object
Year Optional	String Birth year of the creditor Example – "1970"
Month Optional	String Birth month of the creditor Example – "11"
Day Optional	String Birth year of the creditor Example – "15"
CreditorPostalAddress Optional	Object
AddressType Optional	String Address type of creditor Example – "HOUSE"
AddressLine1 Optional	String Line 1 of creditor address Example – "3745 SW VENEZULA CUBARD IRANMA"
AddressLine2 Optional	String Line 2 of creditor address Example – "Suite C"
City Optional	String City name of the creditor address Example – "Pque Central"
State Optional	String State of the creditor address Example – "Caracas"
ZipCode Optional	String Zip code of creditor address location Example – "66610"
CountryCode Optional	String Country code of creditor country Example – "862"
Nationality Optional	String Nationality of the creditor Example – "Venezuela"
Country Optional	String Country of the creditor's location Example – "Venezuela"
CreditorContact Optional	Object
PrimaryEmail Optional	String Contact email ID of the creditor Example – "lifetime@lifetime.com"
PrimaryPhone Optional	String Contact phone number of the creditor Example – "0017850010002"
FedDetails Optional	Object
FedSender Optional	Object
Identification Optional	String Identification code of the sender bank of FED Example – "021000018"
IdentificationType Optional	String Identification type of the sender bank of FED Example – "ABA"
Name Optional	String Name of the sender bank of FED Example – "Bank Of New York"
FedReceiver Optional	Object
Identification Optional	String Identification code of the receiver bank of FED Example – "011102502"
IdentificationType Optional	String Identification type of the receiver bank of FED Example – "ABA"
Name Optional	String Name of the receiver bank of FED Example – "Union Savings Bank"
Risk Optional	Object
MachineFingerPrint Optional	Object

cURL

curl --location 'http://localhost:8080/BiReport/rest/eventApi/event' \
--header 'Content-Type: application/json' \
--data-raw '{"InstructionIdentification":"f9a820da-7bcd-4941-b85c-201169ccf41a","EndToEndIdentification":"31fe4401-d804-441e-b67a-44016b99b08f","BeneficiaryInformation":"Client Refund","Reason":"Loan Repayment","Channel":"ACH","TranactionType":"ACH_CREDIT","TranactionCode":"ACH_CREDIT_CCD","Source":"LEDGER","TransactionAmount":{"Amount":"251.00","Currency":"USD"},"Debtor":{"CustomerType":"EXTERNAL","UserType":"UNKNOWN","CustomerNumber":"1834177889","InstitutionNumber":"123456789012345","Name":"Jhon Doe"},"DebtorAccount":{"AccountNumber":"-","AccountType":"CHECKING","AccountName":"General Account","Institution":{"Identification":"021000018","IdentificationType":"ABA","Name":"Bank Of New York"}},"Creditor":{"CustomerType":"ACCOUNT_HOLDER_BUSINESS","UserType":"INDIVIDUAL","Identification":"994140005","IdentificationType":"SSN","CustomerNumber":"169728101301663","Name":"Lucy Ballard","NameInFile":"Lucy B"},"CreditorAccount":{"AccountNumber":"200162780837000","AccountType":"CHECKING","AccountName":"Payments Account","Institution":{"Name":"Union Savings Bank","Identification":"011102502","IdentificationType":"ABA"}},"CreditorDateOfBirth":{"Year":"1970","Month":"11","Day":"15"},"CreditorPostalAddress":{"AddressType":"HOUSE","AddressLine1":"3745 SW VENEZULA CUBARD IRANMA","AddressLine2":"Suite C","City":"Topeka","State":"KS","ZipCode":"66610","CountryCode":"840","Nationality":" VENEZUALA ","Country":"VENEZUALA"},"CreditorContact":{"PrimaryEmail":"lifetime@lifetime.com","PrimaryPhone":"0017850010002"},"FedDetails":{"FedSender":{"Identification":"021000018","IdentificationType":"ABA","Name":"Bank Of New York"},"FedReceiver":{"Identification":"011102502","IdentificationType":"ABA","Name":"Union Savings Bank"}},"Risk":{"MachineFingerPrint":{}}}'

C#

var options = new RestClientOptions("http://localhost:8080")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/BiReport/rest/eventApi/event", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@"    ""InstructionIdentification"": ""f9a820da-7bcd-4941-b85c-201169ccf41a""," + "\n" +
@"    ""EndToEndIdentification"": ""31fe4401-d804-441e-b67a-44016b99b08f""," + "\n" +
@"    ""BeneficiaryInformation"": ""Client Refund""," + "\n" +
@"    ""Reason"": ""Loan Repayment""," + "\n" +
@"    ""Channel"": ""ACH""," + "\n" +
@"    ""TranactionType"": ""ACH_CREDIT""," + "\n" +
@"    ""TranactionCode"": ""ACH_CREDIT_CCD""," + "\n" +
@"    ""Source"": ""LEDGER""," + "\n" +
@"    ""TransactionAmount"": {" + "\n" +
@"        ""Amount"": ""251.00""," + "\n" +
@"        ""Currency"": ""USD""" + "\n" +
@"    }," + "\n" +
@"    ""Debtor"": {" + "\n" +
@"        ""CustomerType"": ""EXTERNAL""," + "\n" +
@"        ""UserType"": ""UNKNOWN""," + "\n" +
@"        ""CustomerNumber"": ""1834177889""," + "\n" +
@"        ""InstitutionNumber"": ""123456789012345""," + "\n" +
@"        ""Name"": ""Jhon Doe""" + "\n" +
@"    }," + "\n" +
@"    ""DebtorAccount"": {" + "\n" +
@"        ""AccountNumber"": ""-""," + "\n" +
@"        ""AccountType"": ""CHECKING""," + "\n" +
@"        ""AccountName"": ""General Account""," + "\n" +
@"        ""Institution"": {" + "\n" +
@"            ""Identification"": ""021000018""," + "\n" +
@"            ""IdentificationType"": ""ABA""," + "\n" +
@"            ""Name"": ""Bank Of New York""" + "\n" +
@"        }" + "\n" +
@"    }," + "\n" +
@"    ""Creditor"": {" + "\n" +
@"        ""CustomerType"": ""ACCOUNT_HOLDER_BUSINESS""," + "\n" +
@"        ""UserType"": ""INDIVIDUAL""," + "\n" +
@"        ""Identification"": ""994140005""," + "\n" +
@"        ""IdentificationType"": ""SSN""," + "\n" +
@"        ""CustomerNumber"": ""169728101301663""," + "\n" +
@"        ""Name"": ""Lucy Ballard""," + "\n" +
@"        ""NameInFile"": ""Lucy B""" + "\n" +
@"    }," + "\n" +
@"    ""CreditorAccount"": {" + "\n" +
@"        ""AccountNumber"": ""200162780837000""," + "\n" +
@"        ""AccountType"": ""CHECKING""," + "\n" +
@"        ""AccountName"": ""Payments Account""," + "\n" +
@"        ""Institution"": {" + "\n" +
@"            ""Name"": ""Union Savings Bank""," + "\n" +
@"            ""Identification"": ""011102502""," + "\n" +
@"            ""IdentificationType"": ""ABA""" + "\n" +
@"        }" + "\n" +
@"    }," + "\n" +
@"    ""CreditorDateOfBirth"": {" + "\n" +
@"        ""Year"": ""1970""," + "\n" +
@"        ""Month"": ""11""," + "\n" +
@"        ""Day"": ""15""" + "\n" +
@"    }," + "\n" +
@"    ""CreditorPostalAddress"": {" + "\n" +
@"        ""AddressType"": ""HOUSE""," + "\n" +
@"        ""AddressLine1"": ""3745 SW VENEZULA CUBARD IRANMA""," + "\n" +
@"        ""AddressLine2"": ""Suite C""," + "\n" +
@"        ""City"": ""Topeka""," + "\n" +
@"        ""State"": ""KS""," + "\n" +
@"        ""ZipCode"": ""66610""," + "\n" +
@"        ""CountryCode"": ""840""," + "\n" +
@"        ""Nationality"": "" VENEZUALA ""," + "\n" +
@"        ""Country"": ""VENEZUALA""" + "\n" +
@"    }," + "\n" +
@"    ""CreditorContact"": {" + "\n" +
@"        ""PrimaryEmail"": ""lifetime@lifetime.com""," + "\n" +
@"        ""PrimaryPhone"": ""0017850010002""" + "\n" +
@"    }," + "\n" +
@"    ""FedDetails"": {" + "\n" +
@"        ""FedSender"": {" + "\n" +
@"            ""Identification"": ""021000018""," + "\n" +
@"            ""IdentificationType"": ""ABA""," + "\n" +
@"            ""Name"": ""Bank Of New York""" + "\n" +
@"        }," + "\n" +
@"        ""FedReceiver"": {" + "\n" +
@"            ""Identification"": ""011102502""," + "\n" +
@"            ""IdentificationType"": ""ABA""," + "\n" +
@"            ""Name"": ""Union Savings Bank""" + "\n" +
@"        }" + "\n" +
@"    }," + "\n" +
@"    ""Risk"": {" + "\n" +
@"        ""MachineFingerPrint"": {}" + "\n" +
@"    }" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "http://localhost:8080/BiReport/rest/eventApi/event"
  method := "POST"

  payload := strings.NewReader(`{
    "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",
    "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",
    "BeneficiaryInformation": "Client Refund",
    "Reason": "Loan Repayment",
    "Channel": "ACH",
    "TranactionType": "ACH_CREDIT",
    "TranactionCode": "ACH_CREDIT_CCD",
    "Source": "LEDGER",
    "TransactionAmount": {
        "Amount": "251.00",
        "Currency": "USD"
    },
    "Debtor": {
        "CustomerType": "EXTERNAL",
        "UserType": "UNKNOWN",
        "CustomerNumber": "1834177889",
        "InstitutionNumber": "123456789012345",
        "Name": "Jhon Doe"
    },
    "DebtorAccount": {
        "AccountNumber": "-",
        "AccountType": "CHECKING",
        "AccountName": "General Account",
        "Institution": {
            "Identification": "021000018",
            "IdentificationType": "ABA",
            "Name": "Bank Of New York"
        }
    },
    "Creditor": {
        "CustomerType": "ACCOUNT_HOLDER_BUSINESS",
        "UserType": "INDIVIDUAL",
        "Identification": "994140005",
        "IdentificationType": "SSN",
        "CustomerNumber": "169728101301663",
        "Name": "Lucy Ballard",
        "NameInFile": "Lucy B"
    },
    "CreditorAccount": {
        "AccountNumber": "200162780837000",
        "AccountType": "CHECKING",
        "AccountName": "Payments Account",
        "Institution": {
            "Name": "Union Savings Bank",
            "Identification": "011102502",
            "IdentificationType": "ABA"
        }
    },
    "CreditorDateOfBirth": {
        "Year": "1970",
        "Month": "11",
        "Day": "15"
    },
    "CreditorPostalAddress": {
        "AddressType": "HOUSE",
        "AddressLine1": "3745 SW VENEZULA CUBARD IRANMA",
        "AddressLine2": "Suite C",
        "City": "Topeka",
        "State": "KS",
        "ZipCode": "66610",
        "CountryCode": "840",
        "Nationality": " VENEZUALA ",
        "Country": "VENEZUALA"
    },
    "CreditorContact": {
        "PrimaryEmail": "lifetime@lifetime.com",
        "PrimaryPhone": "0017850010002"
    },
    "FedDetails": {
        "FedSender": {
            "Identification": "021000018",
            "IdentificationType": "ABA",
            "Name": "Bank Of New York"
        },
        "FedReceiver": {
            "Identification": "011102502",
            "IdentificationType": "ABA",
            "Name": "Union Savings Bank"
        }
    },
    "Risk": {
        "MachineFingerPrint": {}
    }
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var http = require('follow-redirects').http;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': 'localhost',
  'port': 8080,
  'path': '/BiReport/rest/eventApi/event',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",
  "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",
  "BeneficiaryInformation": "Client Refund",
  "Reason": "Loan Repayment",
  "Channel": "ACH",
  "TranactionType": "ACH_CREDIT",
  "TranactionCode": "ACH_CREDIT_CCD",
  "Source": "LEDGER",
  "TransactionAmount": {
    "Amount": "251.00",
    "Currency": "USD"
  },
  "Debtor": {
    "CustomerType": "EXTERNAL",
    "UserType": "UNKNOWN",
    "CustomerNumber": "1834177889",
    "InstitutionNumber": "123456789012345",
    "Name": "Jhon Doe"
  },
  "DebtorAccount": {
    "AccountNumber": "-",
    "AccountType": "CHECKING",
    "AccountName": "General Account",
    "Institution": {
      "Identification": "021000018",
      "IdentificationType": "ABA",
      "Name": "Bank Of New York"
    }
  },
  "Creditor": {
    "CustomerType": "ACCOUNT_HOLDER_BUSINESS",
    "UserType": "INDIVIDUAL",
    "Identification": "994140005",
    "IdentificationType": "SSN",
    "CustomerNumber": "169728101301663",
    "Name": "Lucy Ballard",
    "NameInFile": "Lucy B"
  },
  "CreditorAccount": {
    "AccountNumber": "200162780837000",
    "AccountType": "CHECKING",
    "AccountName": "Payments Account",
    "Institution": {
      "Name": "Union Savings Bank",
      "Identification": "011102502",
      "IdentificationType": "ABA"
    }
  },
  "CreditorDateOfBirth": {
    "Year": "1970",
    "Month": "11",
    "Day": "15"
  },
  "CreditorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "3745 SW VENEZULA CUBARD IRANMA",
    "AddressLine2": "Suite C",
    "City": "Topeka",
    "State": "KS",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Nationality": " VENEZUALA ",
    "Country": "VENEZUALA"
  },
  "CreditorContact": {
    "PrimaryEmail": "lifetime@lifetime.com",
    "PrimaryPhone": "0017850010002"
  },
  "FedDetails": {
    "FedSender": {
      "Identification": "021000018",
      "IdentificationType": "ABA",
      "Name": "Bank Of New York"
    },
    "FedReceiver": {
      "Identification": "011102502",
      "IdentificationType": "ABA",
      "Name": "Union Savings Bank"
    }
  },
  "Risk": {
    "MachineFingerPrint": {}
  }
});

req.write(postData);

req.end();

Body

{
  "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",
  "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",
  "BeneficiaryInformation": "Client Refund",
  "Reason": "Loan Repayment",
  "Channel": "ACH",
  "TranactionType": "ACH_CREDIT",
  "TranactionCode": "ACH_CREDIT_CCD",
  "Source": "LEDGER",
  "TransactionAmount": {
    "Amount": "251.00",
    "Currency": "USD"
  },
  "Debtor": {
    "CustomerType": "EXTERNAL",
    "UserType": "UNKNOWN",
    "CustomerNumber": "1834177889",
    "InstitutionNumber": "123456789012345",
    "Name": "Jhon Doe"
  },
  "DebtorAccount": {
    "AccountNumber": "-",
    "AccountType": "CHECKING",
    "AccountName": "General Account",
    "Institution": {
      "Identification": "021000018",
      "IdentificationType": "ABA",
      "Name": "Bank Of New York"
    }
  },
  "Creditor": {
    "CustomerType": "ACCOUNT_HOLDER_BUSINESS",
    "UserType": "INDIVIDUAL",
    "Identification": "994140005",
    "IdentificationType": "SSN",
    "CustomerNumber": "169728101301663",
    "Name": "Lucy Ballard",
    "NameInFile": "Lucy B"
  },
  "CreditorAccount": {
    "AccountNumber": "200162780837000",
    "AccountType": "CHECKING",
    "AccountName": "Payments Account",
    "Institution": {
      "Name": "Union Savings Bank",
      "Identification": "011102502",
      "IdentificationType": "ABA"
    }
  },
  "CreditorDateOfBirth": {
    "Year": "1970",
    "Month": "11",
    "Day": "15"
  },
  "CreditorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "3745 SW VENEZULA CUBARD IRANMA",
    "AddressLine2": "Suite C",
    "City": "Topeka",
    "State": "KS",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Nationality": " VENEZUALA ",
    "Country": "VENEZUALA"
  },
  "CreditorContact": {
    "PrimaryEmail": "lifetime@lifetime.com",
    "PrimaryPhone": "0017850010002"
  },
  "FedDetails": {
    "FedSender": {
      "Identification": "021000018",
      "IdentificationType": "ABA",
      "Name": "Bank Of New York"
    },
    "FedReceiver": {
      "Identification": "011102502",
      "IdentificationType": "ABA",
      "Name": "Union Savings Bank"
    }
  },
  "Risk": {
    "MachineFingerPrint": {}
  }
}

Response: 200

Payload Parameters

Parameter	Description
id	String ID of the request Example – "2102262c-8a21-4144-81a2-745e442f36d3"
jsonrpc	String JSON-RPC version used for the API Example – "2.0"
method	String API method Example – "ce.event"
result	Object
resp	String Type of response Example – "event"
status	String Status of the event Example – "1"
riskScore	Number Estimated Risk score of the transaction Example – 953
signalScore	Number Signal reliability score of the transaction Example – 877
scenarioScore	Number Score of specific scenarios related to the transaction event Example – 0
tokenScore	Number Score of token authentication used in the transaction Example – 0
categoryScore	Number Event category score of transaction Example – 0
ofacConfidentScore	Number Estimated score of compliance with OFAC regulations Example – 76
debtorProfileId	String Unique ID of debtor profile Example – "587D9FA3AC2CAB425ADD3B5E3312289E"
creditorProfileId	String Unique ID of creditor profile Example – "2CED9F48EE3B49D97D9263F1AEAB26D8"
error	null Shows information, if any error occurs during transaction Example – null

{
  "id": "2102262c-8a21-4144-81a2-745e442f36d3",
  "jsonrpc": "2.0",
  "method": "ce.event",
  "result": {
    "resp": "event",
    "status": "1",
    "riskScore": 953,
    "signalScore": 877,
    "scenarioScore": 0,
    "tokenScore": 0,
    "categoryScore": 0,
    "ofacConfidentScore": 76,
    "debtorProfileId": "587D9FA3AC2CAB425ADD3B5E3312289E",
    "creditorProfile": "2CED9F48EE3B49D97D9263F1AEAB26D8"
  },
  "error": null
}